docs: add api reference section - #716
Open
kacperzolkiewski wants to merge 43 commits into
Open
Conversation
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds full API reference documentation pages for the library’s two main public components (EnrichedTextInput editor and EnrichedText renderer), replacing prior TODO placeholders.
Changes:
- Documented
EnrichedTextprops, types, remarks, and platform compatibility. - Added a comprehensive
EnrichedTextInputAPI reference including props, ref methods, and style/type definitions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/docs/api-reference/enriched-text.md | Adds EnrichedText API reference with prop documentation and related types. |
| docs/docs/api-reference/enriched-text-input.md | Adds EnrichedTextInput API reference covering props, ref methods, and styling/type details. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
hejsztynx
requested changes
Jul 21, 2026
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
hejsztynx
approved these changes
Jul 21, 2026
…/docs-api-reference
Co-authored-by: Igor Furgała <74370735+exploIF@users.noreply.github.com>
…/docs-api-reference
szydlovsky
approved these changes
Aug 10, 2026
exploIF
reviewed
Aug 11, 2026
|
|
||
| | Type | Default | Platforms | | ||
| | ------------------- | ------- | ------------ | | ||
| | `ContextMenuItem[]` | - | Android, iOS | |
Collaborator
There was a problem hiding this comment.
That's a general note, but let's remove Default column for callback, there is no option to have a default callback implemented
|
|
||
| ```ts | ||
| interface OnChangeStateEvent { | ||
| bold: { isActive: boolean; isConflicting: boolean; isBlocking: boolean }; |
Collaborator
There was a problem hiding this comment.
Can we make it more readable? I think it makes sense to extract { isActive: boolean; isConflicting: boolean; isBlocking: boolean } to a separate interface and reuse it whenever possible. Currently it's hard to see difference between styles
Comment on lines
+398
to
+403
| :::tip | ||
|
|
||
| If you don't need the plain text value, omit `onChangeText` - continuous text | ||
| extraction can have performance implications. | ||
|
|
||
| ::: |
Collaborator
There was a problem hiding this comment.
Let's remove it. It's true for html, but impact when using raw text should be minimal, not worth mentioning it imo
| | ----------------------------------------------------------- | ------- | ----------------- | | ||
| | `(event: NativeSyntheticEvent<OnPasteImagesEvent>) => void` | - | Android, iOS, Web | | ||
|
|
||
| :::tip |
Collaborator
There was a problem hiding this comment.
Let's make it note instead
| - For the full list of supported tags and style conflicts, see | ||
| [HTML format and supported tags](/fundamentals/html-format-and-supported-tags). | ||
|
|
||
| ## Platform compatibility |
|
|
||
| ## Props | ||
|
|
||
| All props are optional except `children`, which is required. |
Collaborator
There was a problem hiding this comment.
Suggested change
| All props are optional except `children`, which is required. | |
| All props are optional except `children`. |
except already desires that this one is required ;)
|
|
||
| | Type | Default | Platforms | | ||
| | -------- | ------- | ------------ | | ||
| | `number` | `0` | Android, iOS | |
Collaborator
There was a problem hiding this comment.
Really default is 0? It sounds weird to me, isn't it undefined?
|
|
||
| - `EnrichedText` is read-only. Use [`EnrichedTextInput`](/api-reference/enriched-text-input) | ||
| when the user needs to edit content. | ||
| - Pass the HTML string as `children`, not as a `value` prop. |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Pass the HTML string as `children`, not as a `value` prop. |
I think It's redundant
Comment on lines
+268
to
+271
|
|
||
| ## Platform compatibility | ||
|
|
||
| <PlatformCompatibility android ios web /> |
Collaborator
There was a problem hiding this comment.
I think it's not needed
Suggested change
| ## Platform compatibility | |
| <PlatformCompatibility android ios web /> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add Api reference section to docs